<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
    <meta charset="utf-8" />
    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
      <link rel="shortcut icon" href="../../img/favicon.ico" />
    <title>配置文件 - GCTG SoftWare</title>
    <link rel="stylesheet" href="../../css/theme.css" />
    <link rel="stylesheet" href="../../css/theme_extra.css" />
        <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
        <link href="../../css/extra.css" rel="stylesheet" />
    
      <script>
        // Current page data
        var mkdocs_page_name = "\u914d\u7f6e\u6587\u4ef6";
        var mkdocs_page_input_path = "user-guide\\configuration.md";
        var mkdocs_page_url = null;
      </script>
    
    <script src="../../js/jquery-3.6.0.min.js" defer></script>
    <!--[if lt IE 9]>
      <script src="../../js/html5shiv.min.js"></script>
    <![endif]-->
      <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
      <script>hljs.initHighlightingOnLoad();</script> 
</head>

<body class="wy-body-for-nav" role="document">

  <div class="wy-grid-for-nav">
    <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
    <div class="wy-side-scroll">
      <div class="wy-side-nav-search">
          <a href="../.." class="icon icon-home"> GCTG SoftWare
        </a><div role="search">
  <form id ="rtd-search-form" class="wy-form" action="../../search.html" method="get">
      <input type="text" name="q" placeholder="Search docs" title="Type search term here" />
  </form>
</div>
      </div>

      <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
              <ul>
                <li class="toctree-l1"><a class="reference internal" href="../..">主页</a>
                </li>
              </ul>
              <p class="caption"><span class="caption-text">用户指南</span></p>
              <ul class="current">
                  <li class="toctree-l1"><a class="reference internal" href="../writing-your-docs/">开发文档</a>
                  </li>
                  <li class="toctree-l1"><a class="reference internal" href="../styling-your-docs/">设置文档样式</a>
                  </li>
                  <li class="toctree-l1 current"><a class="reference internal current" href="./">配置文件</a>
    <ul class="current">
    <li class="toctree-l2"><a class="reference internal" href="#_2">简介</a>
    </li>
    <li class="toctree-l2"><a class="reference internal" href="#_3">项目信息</a>
        <ul>
    <li class="toctree-l3"><a class="reference internal" href="#site_name">site_name</a>
    </li>
    <li class="toctree-l3"><a class="reference internal" href="#site_url">site_url</a>
    </li>
    <li class="toctree-l3"><a class="reference internal" href="#repo_url">repo_url</a>
    </li>
    <li class="toctree-l3"><a class="reference internal" href="#repo_name">repo_name</a>
    </li>
    <li class="toctree-l3"><a class="reference internal" href="#edit_uri">edit_uri</a>
    </li>
    <li class="toctree-l3"><a class="reference internal" href="#site_description">site_description</a>
    </li>
    <li class="toctree-l3"><a class="reference internal" href="#site_author">site_author</a>
    </li>
    <li class="toctree-l3"><a class="reference internal" href="#copyright">copyright</a>
    </li>
    <li class="toctree-l3"><a class="reference internal" href="#google_analytics">google_analytics</a>
    </li>
    <li class="toctree-l3"><a class="reference internal" href="#remote_branch">remote_branch</a>
    </li>
    <li class="toctree-l3"><a class="reference internal" href="#remote_name">remote_name</a>
    </li>
        </ul>
    </li>
    <li class="toctree-l2"><a class="reference internal" href="#_4">文档布局</a>
        <ul>
    <li class="toctree-l3"><a class="reference internal" href="#nav">nav</a>
    </li>
        </ul>
    </li>
    <li class="toctree-l2"><a class="reference internal" href="#_5">构建目录</a>
        <ul>
    <li class="toctree-l3"><a class="reference internal" href="#theme">theme</a>
    </li>
    <li class="toctree-l3"><a class="reference internal" href="#docs_dir">docs_dir</a>
    </li>
    <li class="toctree-l3"><a class="reference internal" href="#site_dir">site_dir</a>
    </li>
    <li class="toctree-l3"><a class="reference internal" href="#extra_css">extra_css</a>
    </li>
    <li class="toctree-l3"><a class="reference internal" href="#extra_javascript">extra_javascript</a>
    </li>
    <li class="toctree-l3"><a class="reference internal" href="#extra_templates">extra_templates</a>
    </li>
    <li class="toctree-l3"><a class="reference internal" href="#extra">extra</a>
    </li>
        </ul>
    </li>
    <li class="toctree-l2"><a class="reference internal" href="#_6">预览控制</a>
        <ul>
    <li class="toctree-l3"><a class="reference internal" href="#use_directory_urls">use_directory_urls</a>
    </li>
    <li class="toctree-l3"><a class="reference internal" href="#strict">strict</a>
    </li>
    <li class="toctree-l3"><a class="reference internal" href="#dev_addr">dev_addr</a>
    </li>
        </ul>
    </li>
    <li class="toctree-l2"><a class="reference internal" href="#_7">格式化选项</a>
        <ul>
    <li class="toctree-l3"><a class="reference internal" href="#markdown_extensions">markdown_extensions</a>
    </li>
    <li class="toctree-l3"><a class="reference internal" href="#plugins">plugins</a>
        <ul>
    <li class="toctree-l4"><a class="reference internal" href="#search">Search</a>
    </li>
        </ul>
    </li>
        </ul>
    </li>
    </ul>
                  </li>
                  <li class="toctree-l1"><a class="reference internal" href="../deploying-your-docs/">部署文档</a>
                  </li>
                  <li class="toctree-l1"><a class="reference internal" href="../plugins/">插件</a>
                  </li>
              </ul>
              <p class="caption"><span class="caption-text">关于</span></p>
              <ul>
                  <li class="toctree-l1"><a class="reference internal" href="../../about/release-notes/">发行说明</a>
                  </li>
                  <li class="toctree-l1"><a class="reference internal" href="../../about/license/">许可</a>
                  </li>
              </ul>
      </div>
    </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
      <nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="../..">GCTG SoftWare</a>
        
      </nav>
      <div class="wy-nav-content">
        <div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
  <ul class="wy-breadcrumbs">
    <li><a href="../.." class="icon icon-home" alt="Docs"></a> &raquo;</li>
          <li>用户指南 &raquo;</li>
      <li>配置文件</li>
    <li class="wy-breadcrumbs-aside">
    </li>
  </ul>
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div class="section" itemprop="articleBody">
              
                <h1 id="_1">配置文件</h1>
<p>所有可用配置选项的指南。</p>
<hr />
<h2 id="_2">简介</h2>
<p>始终使用名为<code>mkdocs.yml</code>的位于项目目录中的YAML文件来进行设置。</p>
<p>此配置文件必须包含<code>site_name</code>设置。 所有其他设置都是可选项。</p>
<h2 id="_3">项目信息</h2>
<h3 id="site_name">site_name</h3>
<p>这是一个<strong>必需的设置</strong>，应该是一个字符串，用作项目文档的主标题。 例如：</p>
<pre><code class="language-yaml">site_name: Marshmallow Generator
</code></pre>
<p>渲染主题时，此设置将作为<code>site_name</code>上下文变量传递。</p>
<h3 id="site_url">site_url</h3>
<p>设置站点的规范URL。 这将添加带有规范URL的链接标记到生成的HTML标头。</p>
<p><strong>默认值</strong>： <code>null</code></p>
<h3 id="repo_url">repo_url</h3>
<p>置后，在每个页面上提供指向您的存储库（GitHub，Bitbucket，GitLab，...）的链接。</p>
<pre><code class="language-yaml">repo_url: https://github.com/example/repository/
</code></pre>
<p><strong>默认值</strong>： <code>null</code></p>
<h3 id="repo_name">repo_name</h3>
<p>设置后，在每个页面上提供指向存储库的链接的名称。</p>
<p><strong>默认值</strong>： <code>'GitHub'</code>, <code>'Bitbucket'</code> or <code>'GitLab'</code>， 如果<code>repo_url</code>不能匹配这些域名，则使用来自<code>repo_url</code>的域名。</p>
<h3 id="edit_uri">edit_uri</h3>
<p>Path from the base <code>repo_url</code> to the docs directory when directly viewing a page, accounting for specifics of the repository host (e.g. GitHub, Bitbucket, etc), the branch, and the docs directory itself. MkDocs concatenates <code>repo_url</code> and <code>edit_uri</code>, and appends the input path of the page.
直接查看页面时从基础<code>repo_url</code>到docs目录的路径，考虑存储库主机（例如GitHub，Bitbucket等），分支和docs目录本身的细节。 MkDocs连接<code>repo_url</code>和<code>edit_uri</code>，并附加页面的输入路径。</p>
<p>设置后，如果您的主题支持它，则直接提供源存储库中页面的链接。 这样可以更轻松地查找和编辑页面的源。 如果未设置<code>repo_url</code>，则忽略此选项。 在某些主题上，设置此选项可能会导致使用编辑链接代替存储库链接。 其他主题可能会显示这两个链接。</p>
<p><code>edit_uri</code>支持查询（'？'）和片段（'＃'）字符。 对于使用查询或片段访问文件的存储库主机，可以按如下方式设置<code>edit_uri</code>。 （注意URI中的<code>？</code>和<code>#</code> ...）</p>
<pre><code class="language-yaml"># Query string example
edit_uri: '?query=root/path/docs/'
</code></pre>
<pre><code class="language-yaml"># Hash fragment example
edit_uri: '#root/path/docs/'
</code></pre>
<p>对于其他存储库主机，只需指定docs目录的相对路径即可。</p>
<pre><code class="language-yaml"># Query string example
edit_uri: root/path/docs/
</code></pre>
<p>!!! note "注意："
    在一些已知的主机（特别是GitHub，Bitbucket和GitLab）上，<code>edit_uri</code>是从'repo_url'派生出来的，不需要手动设置。 只需定义一个<code>repo_url</code>就会自动填充<code>edit_uri</code>配置设置。</p>
<pre><code>例如，对于GitHub或GitLab托管的存储库，`edit_uri`将自动设置为`edit/master/docs/`（注意`edit`路径和`master`分支）。

对于Bitbucket托管的存储库，等效的`edit_uri`将自动设置为`src/default/docs/`（注意`src`路径和`default`分支）。

要使用与默认值不同的URI（例如不同的分支），只需将`edit_uri`设置为所需的字符串即可。如果您不希望页面上显示任何“编辑URL链接”，请将`edit_uri`设置为空字符串以禁用自动设置。
</code></pre>
<p>!!! warning "警告："
    在GitHub和GitLab上，默认的“编辑”路径（<code>edit/master/docs/</code>）在在线编辑器中打开页面。此功能要求用户拥有并已登录GitHub/GitLab帐户。 否则，用户将被重定向到登录/注册页面。 或者，使用“blob”路径（<code>blob/master/docs/</code>）打开只读视图，该视图支持匿名访问。</p>
<p><strong>默认值</strong>：<code>edit/master/docs/</code>用于GitHub和GitLab存储库，<code>src/default/docs/</code>用于Bitbucket存储库，如果<code>repo_url</code>匹配那些域，否则为<code>null</code></p>
<h3 id="site_description">site_description</h3>
<p>设置站点描述。 这将为生成的HTML标头添加元标记。</p>
<p><strong>默认值</strong>： <code>null</code></p>
<h3 id="site_author">site_author</h3>
<p>设置作者的姓名。 这将为生成的HTML标头添加元标记。</p>
<p><strong>默认值</strong>： <code>null</code></p>
<h3 id="copyright">copyright</h3>
<p>设置版权信息以包含在主题的文档中。</p>
<p><strong>默认值</strong>： <code>null</code></p>
<h3 id="google_analytics">google_analytics</h3>
<p>设置Google Analytics跟踪配置。</p>
<pre><code class="language-yaml">google_analytics: ['UA-36723568-3', 'mkdocs.org']
</code></pre>
<p><strong>默认值</strong>： <code>null</code></p>
<h3 id="remote_branch">remote_branch</h3>
<p>当使用<code>gh-deploy</code>来部署到Github Pages时，设置欲远程提交到的分支。可以通过<code>gh-deploy</code>中的命令行选项覆盖此选项。</p>
<p><strong>默认值</strong>： <code>gh-pages</code></p>
<h3 id="remote_name">remote_name</h3>
<p>当使用<code>gh-deploy</code>部署到Github Pages时，设置要推送到的远程名称。 可以通过<code>gh-deploy</code>中的命令行选项覆盖此选项。</p>
<p><strong>默认值</strong>： <code>origin</code></p>
<h2 id="_4">文档布局</h2>
<h3 id="nav">nav</h3>
<p>此设置用于确定站点的全局导航的格式和布局。 例如，以下内容将创建“Introduction”，“User Guide”和“About”导航项。</p>
<pre><code class="language-yaml">nav:
    - 'Introduction': 'index.md'
    - 'User Guide': 'user-guide.md'
    - 'About': 'about.md'
</code></pre>
<p>所有路径必须相对于<code>mkdocs.yml</code>配置文件。 有关更详细的细分，请参阅[配置页面和导航]部分，包括如何创建子导航。</p>
<p>导航项目还可能包括指向外部站点的链接。 虽然标题对于内部链接是可选的，但外部链接需要它们。 外部链接可以是完整URL或相对URL。 假定在文件中找不到的任何路径都是外部链接。</p>
<pre><code class="language-yaml">nav:
    - Home: index.md
    - User Guide: user-guide.md
    - Bug Tracker: https://example.com/
</code></pre>
<p>在上面的示例中，前两个项指向本地文件，而第三个指向外部站点。</p>
<p>但是，有时MkDocs站点托管在项目站点的子目录中，您可能希望链接到同一站点的其他部分而不包括完整域。 在这种情况下，您可以使用和适当的相对URL。</p>
<pre><code class="language-yaml">site_url: https://example.com/foo/

nav:
    - Home: ../
    - User Guide: user-guide.md
    - Bug Tracker: /bugs/
</code></pre>
<p>在上面的示例中，使用了两种不同风格的外部链接。 首先请注意，<code>site_url</code>表示MkDocs站点托管在域的<code>/foo/</code>子目录中。 因此，“Home”导航项是一个相对链接，它将一个级别提升到服务器根目录并有效地指向“https:// example.com/”。 “Bug Tracker”项使用来自服务器根目录的绝对路径，并有效地指向“https://example.com/bugs/”。 当然，“User Guide”指向本地MkDocs页面。</p>
<p><strong>默认值</strong>：默认情况下，<code>nav</code>将包含在<code>docs_dir</code>及其子目录中找到的所有Markdown文件的字母数字排序的嵌套列表。如果没有找到它将是<code>[]</code>（空列表）。</p>
<h2 id="_5">构建目录</h2>
<h3 id="theme">theme</h3>
<p>设置文档站点的主题和主题特定配置。 可以是字符串或一组键/值对。</p>
<p>如果是字符串，则必须是已知安装主题的字符串名称。 有关可用主题的列表，请访问[样式化您的文档]。</p>
<p>一组示例键/值对可能如下所示：</p>
<pre><code class="language-yaml">theme:
    name: mkdocs
    custom_dir: my_theme_customizations/
    static_templates:
        - sitemap.html
    include_sidebar: false
</code></pre>
<p>如果是一组键/值对，则可以定义以下嵌套键：</p>
<p>!!! block ""</p>
<pre><code>#### name:

已知安装主题的字符串名称。 有关可用主题的列表，请访问[样式化您的文档]。

#### custom_dir:

包含自定义主题的目录。 这可以是相对目录，在这种情况下，它相对于包含配置文件的目录进行解析，或者它可以是来自本地文件系统根目录的绝对目录路径。

如果您想要调整现有主题，请参阅[样式化您的文档][theme_dir]了解详细信息。

如果您想从头开始构建自己的主题，请参阅[自定义主题]。

#### static_templates:

要呈现为静态页面的模板列表。 模板必须位于主题的模板目录中或主题配置中定义的`custom_dir`中。

#### 主题特定关键字

还可以定义主题支持的任何其他关键字。 有关详细信息，请参阅您正在使用的主题的文档。
</code></pre>
<p><strong>默认值</strong>： <code>'mkdocs'</code></p>
<h3 id="docs_dir">docs_dir</h3>
<p>源文档markdown文件的目录。 这可以是相对目录，在这种情况下，它相对于包含配置文件的目录进行解析，或者它可以是来自本地文件系统根目录的绝对目录路径。</p>
<p><strong>默认值</strong>： <code>'docs'</code></p>
<h3 id="site_dir">site_dir</h3>
<p>为输出HTML和其他文件而创建的目录。 这可以是相对目录，在这种情况下，它相对于包含配置文件的目录进行解析，或者它可以是来自本地文件系统根目录的绝对目录路径。</p>
<p><strong>默认值</strong>： <code>'site'</code></p>
<p>!!! note "注意："
    如果您使用的是源代码控制，通常需要确保<em>输出</em>文件未提交到存储库中，并且只保留<em>源文件</em>在版本控制下。 例如，如果使用<code>git</code>，您可以将以下行添加到<code>.gitignore</code>文件中：</p>
<pre><code>    site/

如果您正在使用其他源代码控制工具，则需要查看有关如何忽略特定目录的文档。
</code></pre>
<h3 id="extra_css">extra_css</h3>
<p>设置主题中包含到<code>docs_dir</code>中的CSS文件列表。 例如，以下示例将在[docs_dir]（＃docs_dir）的css子目录中包含extra.css文件。</p>
<pre><code class="language-yaml">extra_css:
    - css/extra.css
    - css/second_extra.css
</code></pre>
<p><strong>默认值</strong>： <code>[]</code> (an empty list).</p>
<h3 id="extra_javascript">extra_javascript</h3>
<p>设置要包含到主题中的<code>docs_dir</code>中的JavaScript文件列表。请参阅<a href="#extra_css">extra_css</a>中的示例以了解用法。</p>
<p><strong>默认值</strong>： <code>[]</code> (an empty list).</p>
<h3 id="extra_templates">extra_templates</h3>
<p>设置要由MkDocs构建的<code>docs_dir</code>中的模板列表。 要了解有关为MkDocs编写模板的更多信息，请阅读有关[自定义主题]的文档，特别是有关模板的[可用变量]的部分。 有关用法，请参阅<a href="#extra_css">extra_css</a>中的示例。</p>
<p><strong>默认值</strong>： <code>[]</code> (an empty list).</p>
<h3 id="extra">extra</h3>
<p>一组键值对，其中值可以是任何有效的YAML构造，将传递给模板。 这在创建自定义主题时具有很大的灵活性。</p>
<p>例如，如果您使用的主题支持显示项目版本，则可以将其传递给主题，如下所示：</p>
<pre><code class="language-yaml">extra:
    version: 1.0
</code></pre>
<p><strong>默认值</strong>： 默认情况下，“extra”将是一个空键值映射。</p>
<h2 id="_6">预览控制</h2>
<h3 id="use_directory_urls">use_directory_urls</h3>
<p>此设置控制用于链接的样式。</p>
<p>下表演示了将“use_directory_urls”设置为“true”或“false”时网站上显示的URL的不同之处。</p>
<table>
<thead>
<tr>
<th>源文件</th>
<th>use_directory_urls: true</th>
<th>use_directory_urls: false</th>
</tr>
</thead>
<tbody>
<tr>
<td>index.md</td>
<td>/</td>
<td>/index.html</td>
</tr>
<tr>
<td>api-guide.md</td>
<td>/api-guide/</td>
<td>/api-guide.html</td>
</tr>
<tr>
<td>about/license.md</td>
<td>/about/license/</td>
<td>/about/license.html</td>
</tr>
</tbody>
</table>
<p><code>use_directory_urls：true</code>的默认样式创建了更多用户友好的URL，通常是您想要使用的。</p>
<p>如果您希望在直接从文件系统打开页面时保持文档正确链接，则备用样式有时会很有用，因为它会创建直接指向目标<em>文件</em>而非目标<em>目录</em>的链接。</p>
<p><strong>默认值</strong>： <code>true</code></p>
<h3 id="strict">strict</h3>
<p>确定警告的处理方式。 设置为“true”以在发出警告时停止处理。 设置为“false”以打印警告并继续处理。</p>
<p><strong>默认值</strong>： <code>false</code></p>
<h3 id="dev_addr">dev_addr</h3>
<p>确定运行<code>mkdocs serve</code>时使用的地址。 必须是“IP:PORT”格式。</p>
<p>允许设置自定义默认值，而无需在每次调用<code>mkdocs serve</code>命令时通过<code>--dev-addr</code>选项传递它。</p>
<p><strong>默认值</strong>： <code>'127.0.0.1:8000'</code></p>
<h2 id="_7">格式化选项</h2>
<h3 id="markdown_extensions">markdown_extensions</h3>
<p>MkDocs使用<a href="https://python-markdown.github.io/">Python Markdown</a>库将Markdown文件翻译成HTML。 Python Markdown支持各种<a href="https://python-markdown.github.io/extensions/">扩展</a>，可以自定义页面的格式。 此设置允许您启用超出MkDocs默认使用的扩展名列表（<code>meta</code>，<code>toc</code>，<code>tables</code>和<code>fenced_code</code>）。</p>
<p>例如，要启用<a href="https://python-markdown.github.io/extensions/smarty/">SmartyPants排版扩展</a>，请使用：</p>
<pre><code class="language-yaml">markdown_extensions:
    - smarty
</code></pre>
<p>某些扩展提供了自己的配置选项。 如果要设置任何配置选项，则可以嵌套给定扩展支持的任何选项的键/值映射（<code>option_name:option value</code>）。请参阅所用扩展的文档以确定它们所提供的扩展选项。</p>
<p>例如，要在（内置的）<code>toc</code>扩展中启用永久链接，请使用：</p>
<pre><code class="language-yaml">markdown_extensions:
    - toc:
        permalink: True
</code></pre>
<p>请注意冒号（<code>：</code>）必须跟随扩展名（<code>toc</code>），然后在新起的一行上，选项名称和值必须缩进并用冒号分隔。如果要为单个扩展定义多个选项，则必须在单独的一行上分别定义每个选项：</p>
<pre><code class="language-yaml">markdown_extensions:
    - toc:
        permalink: True
        separator: &quot;_&quot;
</code></pre>
<p>为每个扩展名添加一个附加项目到列表中。 如果没有为特定扩展设置的配置选项，则只需省略该扩展的选项：</p>
<pre><code class="language-yaml">markdown_extensions:
    - smarty
    - toc:
        permalink: True
    - sane_lists
</code></pre>
<p>!!! note "延申阅读："
    Python-Markdown文档提供了<a href="https://python-markdown.github.io/extensions/">扩展名列表</a>，它们是开箱即用的。有关给定扩展可用的配置选项列表，请参阅该扩展的文档。</p>
<pre><code>您也可以安装和使用各种[第三方扩展][3rd]。 有关安装说明和可用配置选项，请参阅这些扩展提供的文档。
</code></pre>
<p><strong>默认值</strong>： <code>[]</code> (an empty list).</p>
<h3 id="plugins">plugins</h3>
<p>构建站点时要使用的插件列表（带有可选配置设置）。 有关完整详细信息，请参阅[插件]文档。</p>
<p>如果<code>plugins</code>配置设置在<code>mkdocs.yml</code>配置文件中定义，则忽略任何默认值（例如<code>search</code>），如果要继续使用它们，则需要显式重新启用默认值：</p>
<pre><code class="language-yaml">plugins:
    - search
    - your_other_plugin
</code></pre>
<p>要完全禁用所有插件，包括任何默认值，请将<code>plugins</code>设置为空列表：</p>
<pre><code class="language-yaml">plugins: []
</code></pre>
<p><strong>默认值</strong>： <code>['search']</code> ，MkDocs内置了该'search'插件（“搜索”）.</p>
<h4 id="search">Search</h4>
<p>默认情况下，MkDocs提供了一个搜索插件，它使用<a href="https://lunrjs.com/">lunr.js</a>作为搜索引擎。以下配置选项可用于更改搜索插件的行为：</p>
<h5 id="separator"><strong>separator</strong></h5>
<p>一个正则表达式，它与构建索引时用作单词分隔符的字符相匹配。 默认情况下使用空格和连字符（<code>-</code>）。 要将点（<code>.</code>）添加为单词分隔符，您可以执行以下操作：</p>
<pre><code class="language-yaml">plugins:
    - search:
        separator: '[\s\-\.]+'
</code></pre>
<p><strong>默认值</strong>： <code>'[\s\-]+'</code></p>
<h5 id="lang"><strong>lang</strong></h5>
<p>构建由<a href="https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes">ISO 639-1</a>语言代码标识的搜索索引时使用的语言列表。 使用<a href="https://github.com/MihaiValentin/lunr-languages#lunr-languages-----">Lunr Languages</a>，支持以下语言：</p>
<ul>
<li><code>da</code>: Danish</li>
<li><code>du</code>: Dutch</li>
<li><code>en</code>: English</li>
<li><code>fi</code>: Finnish</li>
<li><code>fr</code>: French</li>
<li><code>de</code>: German</li>
<li><code>hu</code>: Hungarian</li>
<li><code>it</code>: Italian</li>
<li><code>jp</code>: Japanese</li>
<li><code>no</code>: Norwegian</li>
<li><code>pt</code>: Portuguese</li>
<li><code>ro</code>: Romanian</li>
<li><code>ru</code>: Russian</li>
<li><code>es</code>: Spanish</li>
<li><code>sv</code>: Swedish</li>
<li><code>th</code>: Thai</li>
<li><code>tr</code>: Turkish</li>
</ul>
<p>您也可以[贡献其他语言]。</p>
<p>!!! Warning "警告："</p>
<pre><code>虽然搜索支持同时使用多种语言，但最好不要添加其他语言，除非您确实需要它们。 每种附加语言都会增加大量带宽需求并使用更多浏览器资源。一般来说，最好将MkDoc的每个实例保持为单一语言。
</code></pre>
<p>!!! Note "注意："</p>
<pre><code>Lunr Languages目前不包括对中文或其他亚洲语言的支持。 但是，一些用户使用日语报告了不错的结果。
</code></pre>
<p><strong>默认值</strong>： <code>['en']</code></p>
<h5 id="prebuild_index"><strong>prebuild_index</strong></h5>
<p>（可选）生成所有页面的预构建索引，从而为较大的站点提供一些性能改进。在启用之前，请检查您使用的主题是否明确支持使用预建索引（内置主题可以）。</p>
<p>预建索引有两种选择：</p>
<p>使用<a href="https://nodejs.org/">Node.js</a>将<code>prebuild_index</code>设置为<code>True</code>或<code>node</code>。 此选项要求安装Node.js并且命令<code>node</code>在系统路径上。 如果启用此功能并因任何原因失败，则会发出警告。 在构建时可以使用<code>--strict</code>标志来导致这样的失败而不是引发错误。</p>
<p>使用<a href="http://lunr.readthedocs.io/">Lunr.py</a>设置<code>prebuild_index</code>到<code>python</code>。Lunr.py作为mkdocs的一部分安装，并保证与Lunr.js的兼容性，即使在英语以外的语言上也是如此。 如果您发现实质性的不一致或问题，请在<a href="https://github.com/yeraydiazdiaz/lunr.py/issues">Lunr.py's issues</a>上报告，然后再回到Node.js版本。</p>
<p>!!! Note "注意："</p>
<pre><code>在较小的站点上，不建议使用预先构建的索引，因为它会造成带宽显著增加，而对用户几乎没有明显改善。但是，对于较大的站点（数百页），带宽增加相对较小，您的用户会注意到搜索性能的显着提高。
</code></pre>
<p><strong>默认值</strong>： <code>False</code></p>
              
            </div>
          </div><footer>
    <div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
        <a href="../styling-your-docs/" class="btn btn-neutral float-left" title="设置文档样式"><span class="icon icon-circle-arrow-left"></span> Previous</a>
        <a href="../deploying-your-docs/" class="btn btn-neutral float-right" title="部署文档">Next <span class="icon icon-circle-arrow-right"></span></a>
    </div>

  <hr/>

  <div role="contentinfo">
    <!-- Copyright etc -->
  </div>

  Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
          
        </div>
      </div>

    </section>

  </div>

  <div class="rst-versions" role="note" aria-label="Versions">
  <span class="rst-current-version" data-toggle="rst-current-version">
    
    
      <span><a href="../styling-your-docs/" style="color: #fcfcfc">&laquo; Previous</a></span>
    
    
      <span><a href="../deploying-your-docs/" style="color: #fcfcfc">Next &raquo;</a></span>
    
  </span>
</div>
    <script>var base_url = '../..';</script>
    <script src="../../js/theme_extra.js" defer></script>
    <script src="../../js/theme.js" defer></script>
      <script src="../../search/main.js" defer></script>
    <script defer>
        window.onload = function () {
            SphinxRtdTheme.Navigation.enable(true);
        };
    </script>

</body>
</html>
